Pick MkDocs + Material for docs.teemops.com, and write the priority-1 pages - #113
Merged
Merged
Conversation
… pages D-10 deferred the renderer choice until section count and search actually bit; that trigger fired against the eight-section, 34-page IA. Records the choice as D-13: MkDocs with the Material theme, built with `mkdocs build` and deployed to Cloudflare Pages from `site/`. Chosen over Docsify because it renders real static HTML per page rather than client-side, which matters for the evaluator audience arriving via search or a vendor-review link rather than already inside the app — and it adds no new language to the repo, since python3 already backs the link-checker and SVG-validator scripts sitting next to it in user-docs/README.md. `.github/workflows/tests.yml` gained a `docs` job: `mkdocs build --strict`, the existing relative-link checker, and the SVG validator, so a broken nav entry or a dead cross-reference fails CI instead of shipping to docs.teemops.com. Writes the six pages the IA's inventory marks priority 1 and this session hadn't yet: what TOPS is, install, connect your first AWS account, run your first scan, the security model, and reporting a vulnerability — closing the whole evaluator-plus-first-run path. Sourced from the actual UI copy (NewScanModal.vue, Scans/Index.vue), the roadmap's decisions log (D-1, D-2, D-9), docs/PROGRESS.md, and SECURITY.md — deliberately not from docs/architecture.md, which is stale and still describes the pre-pivot hosted-SaaS design. Nothing here documents PCI, roles/permissions, MFA, report export or scheduled scans, per docs/PROGRESS.md. Connecting the Cloudflare Pages project itself and trimming README.md's setup section are still open — the former needs dashboard access this commit can't have, the latter needs an install page to link to, which now exists. Signed-off-by: Ben Fellows <kiwifellows@gmail.com> Co-authored-by: Cursor <cursoragent@cursor.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs.teemops.com, deployed via Cloudflare Pages (mkdocs build, outputsite/). Fills in the choice D-10 deliberately deferred until section count and search actually bit.mkdocs.yml,requirements.txt, and the one CSS override the IA's own sample test found necessary (p:has(img) { max-width: none }, so the 900px diagrams aren't capped by the theme's prose measure).docsjob to.github/workflows/tests.yml:mkdocs build --strict, the existing relative-link checker, and the SVG validator — a broken nav entry or dead cross-reference now fails CI instead of shipping todocs.teemops.com.develop, this closes the entire evaluator + first-run priority-1 set (10 of 34 planned pages).NewScanModal.vue,Scans/Index.vue), the roadmap's decisions log (D-1, D-2, D-9),docs/PROGRESS.md, andSECURITY.md— deliberately notdocs/architecture.md, which is stale and still describes the pre-pivot hosted-SaaS design (Firebase as sole auth, encrypted ARNs, EC2/RDS deployment).docs/PROGRESS.md.Not in this PR
docs.teemops.com— needs dashboard access this repo can't provide. Standard flow once ready: Workers & Pages → connect this repo → branchdevelop(or wherever this merges to) → build commandmkdocs build→ output directorysite.README.md's setup section to link intouser-docs/— the IA's own writing order puts this after an install page exists to link to, which it now does, but it's a separate change.Test plan
mkdocs build --strict— all 10 pages + homepage build clean, no broken navuser-docs/README.md's own link-checker — all relative cross-references resolve.github/workflows/tests.ymlandmkdocs.ymlparsesmkdocs servelocallyMade with Cursor